package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.CollegesAddDTO;
import org.jsola.hr.dto.CollegesUpdateDTO;
import org.jsola.hr.query.CollegesQuery;
import org.jsola.hr.vo.CollegesListVO;
import org.jsola.hr.vo.CollegesVO;

import java.util.List;

/**
 * 卫人云-院校
 *
 * @author zhr
 */
@Api(tags = "hr-卫人云-院校")
public interface ICollegesControllerAPI {

    /**
     * 新增卫人云-院校
     * @param collegesAddDTO 卫人云-院校新增实体
     * @return 卫人云-院校展示对象
     */
    @ApiOperation(value = "新增卫人云-院校")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "collegesAddDTO", dataType = "CollegesAddDTO", value = "新增卫人云-院校", paramType = "body")
    })
    Result<CollegesVO> save(CollegesAddDTO collegesAddDTO);


    /**
     * 修改卫人云-院校
     * @param collegesUpdateDTO 卫人云-院校
     * @return 更新数量
     */
    @ApiOperation(value = "修改卫人云-院校")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "collegesUpdateDTO", dataType = "CollegesUpdateDTO", value = "修改卫人云-院校", paramType = "body")
    })
    Result<Integer> update(CollegesUpdateDTO collegesUpdateDTO);




    /**
     * 删除单个卫人云-院校，彻底删除
     * @param collegesId 卫人云-院校id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个卫人云-院校，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "collegesId", dataType = "String", value = "卫人云-院校id", paramType = "path")
    })
    Result<Integer> delete(String collegesId);


    /**
     * 批量删除卫人云-院校，彻底删除
     * @param collegesIds 卫人云-院校id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除卫人云-院校，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "collegesIds", dataType = "String[]", value = "卫人云-院校id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] collegesIds);


    /**
     * 根据卫人云-院校id查询卫人云-院校详情
     * @param collegesId 卫人云-院校id
     * @return 卫人云-院校详情
     */
    @ApiOperation(value="根据卫人云-院校id查询卫人云-院校详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "collegesId", dataType = "String", value = "卫人云-院校id", paramType = "path")
    })
    Result<CollegesVO> findById(String collegesId);


    /**
     * 查询卫人云-院校
     * @param collegesQuery 卫人云-院校查询参数
     * @return page
     */
    @ApiOperation(value="查询卫人云-院校")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "collegesQuery", dataType = "CollegesQuery", value = "卫人云-院校查询参数", paramType = "query")
    })
    Result<List<CollegesListVO>> listAll(CollegesQuery collegesQuery);


     /**
     * 分页查询卫人云-院校
     * @param collegesQuery 卫人云-院校查询参数
     * @return page
     */
    @ApiOperation(value="分页查询卫人云-院校")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "collegesQuery", dataType = "CollegesQuery", value = "卫人云-院校查询参数", paramType = "query")
    })
    Result<Page<CollegesListVO>> page(CollegesQuery collegesQuery);


}

